Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Bugfix invalid block number or hash #313

Merged
merged 5 commits into from
Jun 25, 2024
Merged

Conversation

devbugging
Copy link
Contributor

@devbugging devbugging commented Jun 24, 2024

Description

Bugfix for a crasher when the block hash or number is nil.

Also improve handling of invalid requests errors.


For contributor use:

  • Targeted PR against master branch
  • Linked to Github issue with discussion and accepted design OR link to spec that describes this work.
  • Code follows the standards mentioned here.
  • Updated relevant documentation
  • Re-reviewed Files changed in the Github PR explorer
  • Added appropriate labels

Summary by CodeRabbit

  • Bug Fixes

    • Improved error handling across various functions to ensure consistent error responses and better logging.
    • Enhanced specific error cases handling for more accurate error messaging.
  • New Features

    • Introduced a comprehensive handleError function to standardize error handling across the API.
  • Chores

    • Updated import statements to include necessary error handling packages.

@devbugging devbugging self-assigned this Jun 24, 2024
Copy link
Contributor

coderabbitai bot commented Jun 24, 2024

Walkthrough

The changes across api/api.go and api/encode_transaction.go focus on standardizing error handling and enhancing logging practices. A new handleError function ensures consistent error management by catching and processing specific types of errors. This update improves error responses and maximizes code maintainability. Additionally, encoding transactions now handle and propagate errors more effectively, enhancing reliability. Overall, these adjustments strengthen the robustness and clarity of the codebase.

Changes

File Change Summary
api/api.go Refactored error handling using handleError function, modified logging, and updated return values.
api/encode_transaction.go Added error handling for tx.MarshalBinary() with enhanced error propagation.

Poem

In bits of code, a rabbit's cheer,
New paths of logic now appear,
With errors caught in careful hands,
Our code now strong, on solid sands.
Logs are clear, responses bright,
A better flow from day to night.
Hop, hop, hooray for changes so dear!


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

Outside diff range and nitpick comments (1)
api/api.go (1)

Line range hint 786-803: Correct error handling for block number retrieval.

The use of errors.Join should be replaced with fmt.Errorf for consistency and correctness. Additionally, ensure the error message clarity and handling logic are correct.

- err := errors.Join(errs.ErrInvalid, fmt.Errorf("neither block number nor hash specified"))
+ err := fmt.Errorf("%w: neither block number nor hash specified", errs.ErrInvalid)
Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 28fae42 and c47eae8.

Files selected for processing (2)
  • api/api.go (7 hunks)
  • api/encode_transaction.go (2 hunks)
Additional comments not posted (1)
api/api.go (1)

497-497: Ensure consistent error handling in API calls.

The handleError function is used correctly here to handle errors uniformly across API methods. This change improves the maintainability and consistency of error management.

return tx.MarshalBinary()
enc, err := tx.MarshalBinary()
if err != nil {
return nil, errors.Join(err, errs.ErrInvalid)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Correct error wrapping syntax.

The errors.Join function does not exist in the standard Go errors package. Use fmt.Errorf for wrapping errors to maintain consistency and compatibility.

- return nil, errors.Join(err, errs.ErrInvalid)
+ return nil, fmt.Errorf("%w: %v", errs.ErrInvalid, err)
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
return nil, errors.Join(err, errs.ErrInvalid)
return nil, fmt.Errorf("%w: %v", errs.ErrInvalid, err)

@@ -549,7 +548,7 @@ func (b *BlockChainAPI) GetLogs(

l, err := b.blocks.LatestEVMHeight()
if err != nil {
return nil, err
return handleError[[]*types.Log](b.logger, err)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Refactor repeated error handling in GetLogs.

The handleError function is used multiple times in the same method. Consider refactoring to reduce redundancy and improve code clarity.

func (b *BlockChainAPI) GetLogs(ctx context.Context, criteria filters.FilterCriteria) ([]*types.Log, error) {
	if err := rateLimit(ctx, b.limiter, b.logger); err != nil {
		return nil, err
	}

	// Existing logic...

	latest, err := b.blocks.LatestEVMHeight()
	if err != nil {
		return handleError[[]*types.Log](b.logger, err)
	}
	latestInt := big.NewInt(int64(latest))

	// Adjusted logic to use `handleError` once at the end.
	res, err := logs.NewRangeFilter(*from, *to, filter, b.receipts).Match()
	return handleError[[]*types.Log](b.logger, err)
}

Also applies to: 565-565, 570-570

Copy link
Collaborator

@m-Peter m-Peter left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@devbugging devbugging merged commit 869af8b into main Jun 25, 2024
2 checks passed
@m-Peter m-Peter deleted the gregor/get-block-number-fix branch July 29, 2024 16:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

2 participants